Skip to main content
GET
/
public
/
v1
/
toppie
/
reporting
/
campaigns
[BETA] Get Campaigns Reporting.
curl --request GET \
  --url https://api.topsort.com/public/v1/toppie/reporting/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "campaigns": [
    {
      "adFormat": "listing",
      "adSpend": 1,
      "agencyCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignName": "<string>",
      "chargedClicks": 1,
      "chargedImpressions": 1,
      "clicks": 1,
      "conversionRate": 123,
      "cpc": 123,
      "ctr": 123,
      "dailyBudget": 1000,
      "endDate": "2023-11-07T05:31:56Z",
      "impressions": 1,
      "isActive": true,
      "purchaseCount": 1,
      "purchaseRevenue": 1,
      "roas": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "targetRoas": 2
    }
  ],
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
next_page
string

Token for retrieving the next page.

​
limit
integer
default:100

Maximum number of campaigns to retrieve.

Required range: 1 <= x <= 1000
​
order_by
enum<string>

The order dimension for the campaigns to be retrieved.

Available options:
campaign_id,
name,
daily_budget,
impressions,
purchase_revenue,
roas,
cpc,
cpm,
ad_spend,
is_active,
ad_format,
start_date,
end_date,
created_at,
ctr,
conversion_rate,
purchase_count,
charged_clicks,
charged_impressions
​
direction
enum<string>

The order direction for the campaigns to be retrieved.

Available options:
asc,
desc
​
start_date
string<date>

Start date for calculating metrics.

​
end_date
string<date>

End date for calculating metrics.

​
search
string
default:""

A search string to filter the names of the campaigns by.

​
campaign_status
enum<string>

The campaign status to filter the campaigns by. Defaults to all statuses.

Available options:
all,
active,
inactive

Response

Successful Response

​
campaigns
AgencyCampaignWithKPIS · object[]
required
​
hasMore
boolean
required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

​
nextPage
string

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum length: 1
Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="